home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload Trio 2 / Shareware Overload Trio Volume 2 (Chestnut CD-ROM).ISO / dir31 / modcln11.zip / MODCLEAN.DOC next >
Text File  |  1993-08-01  |  5KB  |  125 lines
  1.                                 MODCLEAN v1.1
  2.  
  3. - What is MODCLEAN ?
  4.  
  5. MODCLEAN is a small utility that can reduce the size of ProTracker
  6. compatible MODs - without affecting the songs contained in them in
  7. ANY way! It does so by removing useless information from the MODs.
  8. Many MODs contain extra patterns which were made by the composer
  9. but later excluded from the song. It also removes any samples not
  10. used in the song. As you may have guessed, MODCLEAN can not reduce
  11. all MODS - only those containing unused patterns and/or samples.
  12.  
  13. - How good is it ?
  14.  
  15. Quite good! I've tested it on the 70-odd MODs I have on my harddisk
  16. and it reduced about 1/3 of them. Smallest reduction was 1024 bytes
  17. and largest reduction was 50092 bytes! And all of the MODs sounded
  18. just the same as usual when I played them afterwards. I received no
  19. more than four bug reports on v1.0 (all reporting the same bug), so
  20. I think it's OK. Should you, however, come across a MOD that causes
  21. MODCLEAN to crash, I'd really like to hear from you. You can find
  22. my address near the end of this file.
  23.  
  24. - How do I use it ?
  25.  
  26. The syntax for MODCLEAN is:
  27.  
  28.     MODCLEAN <options> <filelist>
  29.  
  30. The filelist can be any number of file specifications. Wildcards are
  31. accepted and so are references to other directories and drives. If you
  32. don't specify an extension to the files, '.MOD' will be used. Note
  33. that MODCLEAN creates a temporary file in the same directory as the
  34. original MOD file. If there's not enough disk space for this tempfile,
  35. MODCLEAN aborts. The tempfile will be deleted after use, except if
  36. you specify the option -B (see below).
  37.  
  38. The options can be any of these:
  39.  
  40. -B    Keep backup of the original MOD. This option is mostly included
  41.     to persuade the inevitable sceptics that MODCLEAN is safe to
  42.     use ;)
  43. -N    Don't reduce any files, just report how much each MOD can be
  44.     reduced.
  45. -I    Print some information about each MOD. The info printed is
  46.     module name, module ID, number of channels, song length (in
  47.     patterns), number of patterns and number of samples. The two
  48.     last numbers are as AFTER a reduction, even if you specify
  49.     -N.
  50.  
  51. - Examples of use
  52.  
  53. MODCLEAN *
  54.   Scans and reduces all MODs in the current directory.
  55. MODCLEAN -N -I D:\SONGS\*
  56.   Prints info about all MODs in the D:\SONGS\ directory. No reduction
  57.   is performed on the modules.
  58. MODCLEAN -B FAB*.MOD
  59.   Cleans up all FAB*.MOD in the current directory, keeping backups of
  60.   all the MODs as FAB*.OLD.
  61.  
  62. - What kinds of MODs are supported ?
  63.  
  64. MODs written by ProTracker, StarTrekker and FastTracker. If you know
  65. what this means, MODCLEAN supports the IDs "M.K.", "M!K!", "6CHN",
  66. "8CHN", "FLT4" and "FLT8". I think there are other valid IDs, but I
  67. don't know what they are... If you don't know where your MOD came
  68. from, just try MODCLEANing it - if it isn't one of the above, you'll
  69. get an error message. In that case, please tell me what the ID is
  70. and I'll add support for it.
  71. NOTE: ModClean does NOT support 15-instrument MODs. These are an old
  72. style of MODs and there's just no way of telling them apart from
  73. other files (they don't use IDs). So if have some MODs that ModClean
  74. won't load, they could be old 15-instrument MODs.
  75.  
  76. - Requirements
  77.  
  78. The program should be able to run on any IBM PC compatible computer.
  79. There are no memory minimums, but the more memory you have, the larger
  80. MODs can be reduced. DOS version should be 3.xx or above (I think).
  81. MODCLEAN does not utilize EMS/XMS, so there is an upper limit to the
  82. size of the MODs to be reduced. On my 386/40 with EMM386, I can read
  83. MODs up to app. 580Kb.
  84.  
  85. - Public Domain
  86.  
  87. This program is in the public domain, which means that you may freely
  88. use and distribute MODCLEAN as you like. However, you're not allowed
  89. to alter the program in ANY way - I still have copyright!
  90. I can not be held responsible for any damage caused by MODCLEAN.
  91.  
  92. - Thanks to:
  93.  
  94. Various people on the InterNet for typing up some docs on the MOD
  95. format. Without those docs, this program would never have been made
  96. (not by me, at least).
  97. These people are: Vishnu/CRB, Andrew Scott and Lars Hamre.
  98.  
  99. Also thanks to Michael J. Sutter (FreeJack/Elven Nation) for testing
  100. the program.
  101.  
  102. - Bugs in earlier version
  103.  
  104. Some MODs have extraneous information in their sequence table, that
  105. ModClean wouldn't blank out. As a result, the MOD will sound distorted
  106. and some of the patterns will be screwed up. If you have come across
  107. this problem and don't have a backup of the MOD, please contact me
  108. and I'll tell you how to "revive" the MOD (It's not all that screwed
  109. up...).
  110.  
  111. - The author
  112.  
  113. My name is Torben Thellefsen and I live in Denmark (that's in Europe,
  114. in case you didn't know). If you want to contact me about MODCLEAN
  115. or anything else, here's the address:
  116.  
  117.     Torben Thellefsen
  118.     Kanalstien 14, 2th
  119.     DK-9000 Aalborg
  120.     Denmark
  121.  
  122.     InterNet: monty@iesd.auc.dk   (expires September 1993)
  123.     FidoNet: Torben Thellefsen    2:234/116
  124.     (InterNet: Torben.Thellefsen@f116.n234.z2.fidonet.org)
  125.